<?php

/*
 +--------------------------------------------------------------------+
 | CiviCRM version 3.3                                                |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2010                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License and the CiviCRM Licensing Exception along                  |
 | with this program; if not, contact CiviCRM LLC                     |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
*/

/**
 *
 * @package CRM
 * @copyright CiviCRM LLC (c) 2004-2010
 * $Id$
 *
 */

require_once 'CRM/Core/Selector/Base.php';
require_once 'CRM/Core/Selector/API.php';

require_once 'CRM/Utils/Pager.php';
require_once 'CRM/Utils/Sort.php';

require_once 'CRM/Contact/BAO/Query.php';

/**
 * This class is used to retrieve and display a range of
 * contacts that match the given criteria (specifically for
 * results of advanced search options.
 *
 */
class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements CRM_Core_Selector_API 
{
    /**
     * This defines two actions- View and Edit.
     *
     * @var array
     * @static
     */
    static $_links = null;

    /**
     * we use desc to remind us what that column is, name is used in the tpl
     *
     * @var array
     * @static
     */
    static $_columnHeaders;

    /**
     * Properties of contact we're interested in displaying
     * @var array
     * @static
     */
    static $_properties = array( 'contact_id', 
                                 'contribution_id',
                                 'contact_type',
                                 'sort_name',
                                 'amount_level',
                                 'total_amount',
                                 'contribution_type',
                                 'contribution_source',
                                 'receive_date',
                                 'thankyou_date',
                                 'contribution_status_id',
                                 'contribution_status',
                                 'cancel_date',
                                 'product_name',
                                 'is_test',
                                 'contribution_recur_id',
                                 'receipt_date',
                                 'membership_id',
                                 'currency',
                                 );

    /** 
     * are we restricting ourselves to a single contact 
     * 
     * @access protected   
     * @var boolean   
     */   
    protected $_single = false;

    /**  
     * are we restricting ourselves to a single contact  
     *  
     * @access protected    
     * @var boolean    
     */    
    protected $_limit = null;

    /**
     * what context are we being invoked from
     *   
     * @access protected     
     * @var string
     */     
    protected $_context = null;

    /**
     * what component context are we being invoked from
     *   
     * @access protected     
     * @var string
     */     
    protected $_compContext = null;

    /**
     * queryParams is the array returned by exportValues called on
     * the HTML_QuickForm_Controller for that page.
     *
     * @var array
     * @access protected
     */
    public $_queryParams;

    /**
     * represent the type of selector
     *
     * @var int
     * @access protected
     */
    protected $_action;

    /** 
     * The additional clause that we restrict the search with 
     * 
     * @var string 
     */ 
    protected $_contributionClause = null;

    /** 
     * The query object
     * 
     * @var string 
     */ 
    protected $_query;

    /**
     * Class constructor
     *
     * @param array $queryParams array of parameters for query
     * @param int   $action - action of search basic or advanced.
     * @param string   $contributionClause if the caller wants to further restrict the search (used in contributions)
     * @param boolean $single are we dealing only with one contact?
     * @param int     $limit  how many contributions do we want returned
     *
     * @return CRM_Contact_Selector
     * @access public
     */
    function __construct(&$queryParams,
                         $action = CRM_Core_Action::NONE,
                         $contributionClause = null,
                         $single = false,
                         $limit = null,
                         $context = 'search',
                         $compContext = null ) 
    {
        // submitted form values
        $this->_queryParams =& $queryParams;

        $this->_single  = $single;
        $this->_limit   = $limit;
        $this->_context = $context;
        $this->_compContext = $compContext;

        $this->_contributionClause = $contributionClause;

        // type of selector
        $this->_action = $action;

        $this->_query = new CRM_Contact_BAO_Query( $this->_queryParams, null, null, false, false,
                                                   CRM_Contact_BAO_Query::MODE_CONTRIBUTE );
        $this->_query->_distinctComponentClause = " DISTINCT(civicrm_contribution.id)";
    }//end of constructor

    /**
     * This method returns the links that are given for each search row.
     * currently the links added for each row are 
     * 
     * - View
     * - Edit
     *
     * @return array
     * @access public
     *
     */
    static function &links( $componentId = null, $componentAction = null, $key = null, $compContext = null  )
    {
        $extraParams = null;
        if ( $componentId ) {
            $extraParams = "&compId={$componentId}&compAction={$componentAction}";
        }
        if ( $compContext ) {
            $extraParams .= "&compContext={$compContext}";
        }
        if ( $key ) {
            $extraParams .= "&key={$key}";
        }
       
        if (!(self::$_links)) {
            self::$_links = array(
                                  CRM_Core_Action::VIEW   => array(
                                                                   'name'     => ts('View'),
                                                                   'url'      => 'civicrm/contact/view/contribution',
                                                                   'qs'       => "reset=1&id=%%id%%&cid=%%cid%%&action=view&context=%%cxt%%&selectedChild=contribute{$extraParams}",
                                                                   'title'    => ts('View Contribution'),
                                                                  ),
                                  CRM_Core_Action::UPDATE => array(
                                                                   'name'     => ts('Edit'),
                                                                   'url'      => 'civicrm/contact/view/contribution',
                                                                   'qs'       => "reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%{$extraParams}",
                                                                   'title'    => ts('Edit Contribution'),
                                                                  ),
                                  CRM_Core_Action::DELETE => array(
                                                                   'name'     => ts('Delete'),
                                                                   'url'      => 'civicrm/contact/view/contribution',
                                                                   'qs'       => "reset=1&action=delete&id=%%id%%&cid=%%cid%%&context=%%cxt%%{$extraParams}",
                                                                   'title'    => ts('Delete Contribution'),
                                                                  ),
                                  );
        }
        return self::$_links;
    } //end of function

    /**
     * getter for array of the parameters required for creating pager.
     *
     * @param 
     * @access public
     */
    function getPagerParams($action, &$params) 
    {
        $params['status']       = ts('Contribution') . ' %%StatusMessage%%';
        $params['csvString']    = null;
        if ( $this->_limit ) {
            $params['rowCount']     = $this->_limit;
        } else {
            $params['rowCount']     = CRM_Utils_Pager::ROWCOUNT;
        }

        $params['buttonTop']    = 'PagerTopButton';
        $params['buttonBottom'] = 'PagerBottomButton';
    }//end of function

    /**
     * Returns total number of rows for the query.
     *
     * @param 
     * @return int Total number of rows 
     * @access public
     */
    function getTotalCount($action)
    {
        return $this->_query->searchQuery( 0, 0, null,
                                           true, false, 
                                           false, false, 
                                           false, 
                                           $this->_contributionClause );
    }

    /**
     * returns all the rows in the given offset and rowCount
     *
     * @param enum   $action   the action being performed
     * @param int    $offset   the row number to start from
     * @param int    $rowCount the number of rows to return
     * @param string $sort     the sql string that describes the sort order
     * @param enum   $output   what should the result set include (web/email/csv)
     *
     * @return int   the total number of rows for this action
     */
    function &getRows($action, $offset, $rowCount, $sort, $output = null) {
        $result = $this->_query->searchQuery( $offset, $rowCount, $sort,
                                              false, false, 
                                              false, false, 
                                              false, 
                                              $this->_contributionClause );
        // process the result of the query
        $rows = array( );
        require_once 'CRM/Event/BAO/Participant.php';
        require_once 'CRM/Contact/BAO/Contact/Utils.php';

        //CRM-4418 check for view/edit/delete
        $permissions = array( CRM_Core_Permission::VIEW );
        if ( CRM_Core_Permission::check( 'edit contributions' ) ) {
            $permissions[] = CRM_Core_Permission::EDIT;
        }
        if ( CRM_Core_Permission::check( 'delete in CiviContribute' ) ) {
            $permissions[] = CRM_Core_Permission::DELETE;
        }
        $mask = CRM_Core_Action::mask( $permissions );
        
        $qfKey = $this->_key;
        $componentId = $componentContext = null;
        if ( $this->_context != 'contribute' ) {
            $qfKey            = CRM_Utils_Request::retrieve( 'key',         'String',   CRM_Core_DAO::$_nullObject ); 
            $componentId      = CRM_Utils_Request::retrieve( 'id',          'Positive', CRM_Core_DAO::$_nullObject );
            $componentAction  = CRM_Utils_Request::retrieve( 'action',      'String',   CRM_Core_DAO::$_nullObject );
            $componentContext = CRM_Utils_Request::retrieve( 'compContext', 'String',   CRM_Core_DAO::$_nullObject );

            if ( ! $componentContext &&
                 $this->_compContext ) {
                $componentContext = $this->_compContext;
                $qfKey = CRM_Utils_Request::retrieve( 'qfKey', 'String', CRM_Core_DAO::$_nullObject, null, false, 'REQUEST' );
            }
        }

        // get all contribution status
        $contributionStatuses = CRM_Core_OptionGroup::values( 'contribution_status', 
                                                              false, false, false, null, 'name', false );
        
        While ($result->fetch()) {
            $row = array();
            // the columns we are interested in
            foreach (self::$_properties as $property) {
                if ( property_exists( $result, $property ) ) {
                    $row[$property] = $result->$property;   
                }         
            }

            // add contribution status name
            $row['contribution_status_name'] = CRM_Utils_Array::value( $row['contribution_status_id'],
                                                                       $contributionStatuses );

            if ( $result->is_pay_later && CRM_Utils_Array::value( 'contribution_status_name', $row ) == 'Pending' ) {
                $row['contribution_status'] .= ' (Pay Later)';
                
            } else if ( CRM_Utils_Array::value( 'contribution_status_name', $row ) == 'Pending' ) {
                $row['contribution_status'] .= ' (Incomplete Transaction)';
            }

            if ( $row['is_test'] ) {
                $row['contribution_type'] = $row['contribution_type'] . ' (test)';
            }
            
            $row['checkbox'] = CRM_Core_Form::CB_PREFIX . $result->contribution_id;
            
            
            
            $actions =  array( 'id'               => $result->contribution_id,
                               'cid'              => $result->contact_id,
                               'cxt'              => $this->_context
                               );
            
            $row['action']       = CRM_Core_Action::formLink( self::links( $componentId, 
                                                                           $componentAction, 
                                                                           $qfKey,
                                                                           $componentContext ),
                                                              $mask, $actions );
            
            $row['contact_type'] = 
                CRM_Contact_BAO_Contact_Utils::getImage( $result->contact_sub_type ? 
                                                         $result->contact_sub_type : $result->contact_type,false,$result->contact_id );

            if ( CRM_Utils_Array::value( 'amount_level', $row ) ) {
                CRM_Event_BAO_Participant::fixEventLevel( $row['amount_level'] );
            }
            
            $rows[] = $row;
        }
        return $rows;

    }    
    
    /**
     * @return array   $qill         which contains an array of strings
     * @access public
     */
  
    // the current internationalisation is bad, but should more or less work
    // for most of "European" languages
    public function getQILL( )
    {
        return $this->_query->qill( );
    }

    /** 
     * returns the column headers as an array of tuples: 
     * (name, sortName (key to the sort array)) 
     * 
     * @param string $action the action being performed 
     * @param enum   $output what should the result set include (web/email/csv) 
     * 
     * @return array the column headers that need to be displayed 
     * @access public 
     */ 
    public function &getColumnHeaders( $action = null, $output = null ) 
    {
        if ( ! isset( self::$_columnHeaders ) ) {
            self::$_columnHeaders = array(
                                          array(
                                                'name'      => ts('Amount'),
                                                'sort'      => 'total_amount',
                                                'direction' => CRM_Utils_Sort::DONTCARE,
                                                ),
                                          array('name'      => ts('Type'),
                                                'sort'      => 'contribution_type_id',
                                                'direction' => CRM_Utils_Sort::DONTCARE,
                                                ),
                                          array(
                                                'name'      => ts('Source'),
                                                'sort'      => 'contribution_source',
                                                'direction' => CRM_Utils_Sort::DONTCARE,
                                                ),
                                          array(
                                                'name'      => ts('Received'),
                                                'sort'      => 'receive_date',
                                                'direction' => CRM_Utils_Sort::DESCENDING,
                                                ),
                                          array(
                                                'name'      => ts('Thank-you Sent'),
                                                'sort'      => 'thankyou_date',
                                                'direction' => CRM_Utils_Sort::DONTCARE,
                                                ),
                                          array(
                                                'name'      => ts('Status'),
                                                'sort'      => 'contribution_status_id',
                                                'direction' => CRM_Utils_Sort::DONTCARE,
                                                ),
                                          array(
                                                'name'      => ts('Premium'),
                                                'sort'      => 'product_name',
                                                'direction' => CRM_Utils_Sort::DONTCARE,
                                                ),
                                          array('desc' => ts('Actions') ),
                                          );

            if ( ! $this->_single ) {
                $pre = array( 
                             array('desc' => ts('Contact Type') ), 
                             array( 
                                   'name'      => ts('Name'), 
                                   'sort'      => 'sort_name', 
                                   'direction' => CRM_Utils_Sort::DONTCARE, 
                                   )
                             );
                self::$_columnHeaders = array_merge( $pre, self::$_columnHeaders );
            }

        }
        return self::$_columnHeaders;
    }
    
    function alphabetQuery( ) {
        return $this->_query->searchQuery( null, null, null, false, false, true );
    }

    function &getQuery( )
    {
        return $this->_query;
    }

    /** 
     * name of export file. 
     * 
     * @param string $output type of output 
     * @return string name of the file 
     */ 
    function getExportFileName( $output = 'csv')
    { 
        return ts('CiviCRM Contribution Search'); 
    }

    function getSummary( )
    {
        return $this->_query->summaryContribution( );
    }

}//end of class


